home *** CD-ROM | disk | FTP | other *** search
/ Netware Super Library / Netware Super Library.iso / mis_cnvt / txt2db / read.me < prev    next >
Text File  |  1994-01-05  |  8KB  |  176 lines
  1. TXT2DBF Version 1.4
  2. Copyright (c) BITwise Computer Services, 1992-1994
  3. All rights reserved.
  4.  
  5.  
  6. OVERVIEW:
  7. ---------
  8. TXT2DBF is a data conversion program that may be used to convert ASCII text
  9. files into database files.  Some possible uses of TXT2DBF include converting
  10. data files from a mainframe computer to a PC and converting formated report
  11. files into useful databases.
  12.  
  13. "Why don't you just use the dBase APPEND FROM ... SDF command ?" you may ask.
  14. Well there are several reasons why TXT2DBF is better in many situations:
  15.  
  16.    1) You may not have dBase or FoxPro handy
  17.    2) You may want to do more formatting or conversion than is possible
  18.         with APPEND FROM ... SDF
  19.    3) You might not want all of the data in the text file
  20.    4) You may want to append data into an existing database that is not
  21.         in the same format as the text file
  22.    5) You can run TXT2DBF from a batch file for automated procedures
  23.  
  24. The power of TXT2DBF lies in the conversion script Files (.T2D) that
  25. specify how the text information is extracted and formatted for the .DBF
  26. output file.  Take a look at the sample TEST.T2D to get an idea of what a
  27. script looks like.  Basically, you specify the file structure of the output
  28. .DBF file along with standard Clipper expressions to retrieve and format
  29. the text data.  Below is a sample script file for a simple 3 field file.
  30.  
  31.    ACCOUNT    |C|  7|  0| SUBSTR(cRec,1,7)
  32.    AMOUNT     |N|  9|  0| VAL(SUBSTR(cRec,8,9))
  33.    DATE       |D|  8|  0| CTOD(SUBSTR(cRec,17,8))
  34.  
  35. As you can see, you merely specify the field name, type, length, and decimals,
  36. along with the expression to retrieve/format the text data.  You can create
  37. any database structure you desire, including memo fields, as long as it adheres
  38. to the specifications of the RDD.  In the expression, you assume that the
  39. variable "cRec" contains one record from the text file.  Refer to the sample
  40. script file TEST.T2D for more detail.
  41.  
  42. The script may also contain Filter Expressions that may be used to limit which
  43. records get appended into the output database.  Sample uses of filter
  44. expressions include:
  45.  
  46.    1) May be used to skip report headers and footers if the source file
  47.       is a formatted report.
  48.  
  49.    2) May be used to filter records based on a field value.
  50.  
  51.    3) May be used to skip blank lines, subtotals, etc..
  52.  
  53. As you can see, this GREATLY increases the usefulness of the program.  Please
  54. refer to the sample script file TEST.T2D for more detail.
  55.  
  56. Since YOU specify how to extract the data, you can skip any data you don't need,
  57. format/convert the data to your heart's content, insert data not found in the
  58. source text file, etc..  To do this kind of formatting with dBase would require
  59. many MODIFIY STRUCTURE and REPLACE passes through the database - TXT2DBF
  60. does it in a single pass!
  61.  
  62.  
  63. PACKING LIST:
  64. -------------
  65.    The following files should be included in the distribution
  66.    ZIP file TXT2DB14.ZIP:
  67.  
  68.    READ.ME       - You're looking at it
  69.    TXT2DBF.EXE   - The executable
  70.    TEST.BAT      - Sample batch file to test TXT2DBF
  71.    TEST.T2D      - Sample conversion script file
  72.    TEST.TXT      - Sample source file
  73.    MAKE.BAT      - Make script for use with Blinker
  74.    TXT2DBF.OBJ   - Object module for linking
  75.    TXT2DBF.CH    - Header file
  76.    RDDSYS.PRG    - Source file to define RDD system (DBFNTX)
  77.    VALIMPDC.PRG  - Source for B_VALIMPDEC()
  78.    CDATE2DT.PRG  - Source for B_CDATE2DT()
  79.    NTHAT.PRG     - Source for B_NTHAT() and B_NTHRAT()
  80.    TXT2DBF.BL    - Blinker link script
  81.    TXT2DBF.RL    - RTLink link script
  82.    SIXCDX.ZIP    - Contains rddsys.prg, txt2dbf.bl, and txt2dbf.rl modified
  83.                    to use the SIXCDX RDD
  84.  
  85.    Please note: The only file required to run the program is TXT2DBF.EXE
  86.    - place this file in your path.
  87.  
  88.  
  89. RUNNING THE PROGRAM:
  90. --------------------
  91. To run the program you must specify the source file, destination file, and
  92. script file:
  93.  
  94.    Example:  TXT2DBF test.txt test[.dbf] test[.t2d] [options]
  95.  
  96. The .DBF file will be created if neccessary.  If the .DBF file already exists,
  97. the structure will be compared to that in the script file to make sure that the
  98. file is compatible, then records will be appended into the existing file.
  99. The program assumes a default extension of .DBF for the destination file and
  100. an extension of .T2D for the script file.
  101.  
  102. Command line options:
  103.  /s - syntax check only
  104.    The specified script file will be processed for syntax errors but no
  105.    conversion processing will take place.  This is useful while debugging a
  106.    new script file or changes.
  107.  
  108.  /i - ignore expression errors
  109.    Normally you wouldn't want to use this option as it can cause a fatal
  110.    runtime error.  This option is primarily intended for registered users that
  111.    are modifying the program to allow the use of external functions in script
  112.    expressions.
  113.  
  114.  /b:<size> - text record buffer size
  115.    This option sets the maximum record length for the script and source text
  116.    files.  The default value is 1024 bytes and should be adequate for most uses.
  117.    The longest record in either text file including the CRLF (carraige return/
  118.    line feed) MUST NOT exceed this value otherwise processing will stop.
  119.  
  120.    For example: If you are processing an 80 column report, a noticable
  121.    performance gain will be realized if you use a buffer size of 100 rather
  122.    than the default of 1024, especially when processing a very lengthy report.
  123.    Please note, however, that you need to allow for embedded printer codes,
  124.    control characters, etc.. when deciding on a buffer size.
  125.  
  126.    NOTE: Multiple options MUST be seperated with spaces.
  127.  
  128.  
  129. TECHNICAL DEPARTMENT:
  130. ---------------------
  131. TXT2DBF was written in CA-Clipper 5.01 and later ported to CA-Clipper 5.2 to
  132. take advantage of some of the new features - primarily the RDD support.  The
  133. program relies very heavily on CA-Clipper's low-level file system,
  134. multi-dimensional arrays, and codeblock evaluation.
  135.  
  136. Modifying the program:
  137. The shareware release contains the link scripts and source code for some sample
  138. conversion functions.  You can enhance the program by writing and linking in
  139. your own conversion functions.  You can specify a different RDD to support
  140. multiple database formats.  You can also modify the link script to tune the
  141. program for speed or memory savings.  You CANNOT, however, modify the main
  142. parsing and conversion engine (TXT2DBF.OBJ).  If you register the program for
  143. $25.00 or more (hint, hint) you will receive the main code to TXT2DBF and you
  144. can modify it to your heart's content.
  145.  
  146.  
  147. SOFTWARE LICENSE:
  148. -----------------
  149. TXT2DBF is being distributed under the shareware concept.  You are free to
  150. distribute the software for evaluation purposes only, provided that you ONLY
  151. distribute the original ZIP file TXT2DB14.ZIP without alteration.  You are
  152. licensed to use the software for a FREE 30 day trial period.  After the 30 day
  153. trial period has expired, you can do one of 3 things:
  154.  
  155.    1) Register the software for $15 and receive a registered version on
  156.       diskette and future upgrade notices.  $25 will get you the same PLUS
  157.       the source code and 1 free upgrade on diskette.
  158.  
  159.    2) Stop using the software and destroy all copies of the software that
  160.       you may have.
  161.  
  162.    3) Continue to use the software without regard for my rights or for the
  163.       rights of my hungry child or my spouse that is nagging me at this very
  164.       moment for spending so much time writing a program that I probably wont
  165.       make any money out of anyway.
  166.  
  167. Please make check or money order out to:
  168.    David Christian DBA BITwise Computer Services.
  169.  
  170. Mail to:
  171.    David Christian
  172.    BITwise Computer Services
  173.    PO Box 97642
  174.    Raleigh, NC 27624-7642
  175.  
  176.